home *** CD-ROM | disk | FTP | other *** search
/ Personal Computer World 2009 February / PCWFEB09.iso / Software / Linux / Kubuntu 8.10 / kubuntu-8.10-desktop-i386.iso / casper / filesystem.squashfs / usr / lib / python2.5 / distutils / unixccompiler.py < prev    next >
Text File  |  2008-10-05  |  14KB  |  321 lines
  1. """distutils.unixccompiler
  2.  
  3. Contains the UnixCCompiler class, a subclass of CCompiler that handles
  4. the "typical" Unix-style command-line C compiler:
  5.   * macros defined with -Dname[=value]
  6.   * macros undefined with -Uname
  7.   * include search directories specified with -Idir
  8.   * libraries specified with -lllib
  9.   * library search directories specified with -Ldir
  10.   * compile handled by 'cc' (or similar) executable with -c option:
  11.     compiles .c to .o
  12.   * link static library handled by 'ar' command (possibly with 'ranlib')
  13.   * link shared library handled by 'cc -shared'
  14. """
  15.  
  16. __revision__ = "$Id: unixccompiler.py 54954 2007-04-25 06:42:41Z neal.norwitz $"
  17.  
  18. import os, sys
  19. from types import StringType, NoneType
  20. from copy import copy
  21.  
  22. from distutils import sysconfig
  23. from distutils.dep_util import newer
  24. from distutils.ccompiler import \
  25.      CCompiler, gen_preprocess_options, gen_lib_options
  26. from distutils.errors import \
  27.      DistutilsExecError, CompileError, LibError, LinkError
  28. from distutils import log
  29.  
  30. # XXX Things not currently handled:
  31. #   * optimization/debug/warning flags; we just use whatever's in Python's
  32. #     Makefile and live with it.  Is this adequate?  If not, we might
  33. #     have to have a bunch of subclasses GNUCCompiler, SGICCompiler,
  34. #     SunCCompiler, and I suspect down that road lies madness.
  35. #   * even if we don't know a warning flag from an optimization flag,
  36. #     we need some way for outsiders to feed preprocessor/compiler/linker
  37. #     flags in to us -- eg. a sysadmin might want to mandate certain flags
  38. #     via a site config file, or a user might want to set something for
  39. #     compiling this module distribution only via the setup.py command
  40. #     line, whatever.  As long as these options come from something on the
  41. #     current system, they can be as system-dependent as they like, and we
  42. #     should just happily stuff them into the preprocessor/compiler/linker
  43. #     options and carry on.
  44.  
  45. def _darwin_compiler_fixup(compiler_so, cc_args):
  46.     """
  47.     This function will strip '-isysroot PATH' and '-arch ARCH' from the
  48.     compile flags if the user has specified one them in extra_compile_flags.
  49.  
  50.     This is needed because '-arch ARCH' adds another architecture to the
  51.     build, without a way to remove an architecture. Furthermore GCC will
  52.     barf if multiple '-isysroot' arguments are present.
  53.     """
  54.     stripArch = stripSysroot = 0
  55.  
  56.     compiler_so = list(compiler_so)
  57.     kernel_version = os.uname()[2] # 8.4.3
  58.     major_version = int(kernel_version.split('.')[0])
  59.  
  60.     if major_version < 8:
  61.         # OSX before 10.4.0, these don't support -arch and -isysroot at
  62.         # all.
  63.         stripArch = stripSysroot = True
  64.     else:
  65.         stripArch = '-arch' in cc_args
  66.         stripSysroot = '-isysroot' in cc_args
  67.  
  68.     if stripArch:
  69.         while 1:
  70.             try:
  71.                 index = compiler_so.index('-arch')
  72.                 # Strip this argument and the next one:
  73.                 del compiler_so[index:index+2]
  74.             except ValueError:
  75.                 break
  76.  
  77.     if stripSysroot:
  78.         try:
  79.             index = compiler_so.index('-isysroot')
  80.             # Strip this argument and the next one:
  81.             del compiler_so[index:index+2]
  82.         except ValueError:
  83.             pass
  84.  
  85.     # Check if the SDK that is used during compilation actually exists,
  86.     # the universal build requires the usage of a universal SDK and not all
  87.     # users have that installed by default.
  88.     sysroot = None
  89.     if '-isysroot' in cc_args:
  90.         idx = cc_args.index('-isysroot')
  91.         sysroot = cc_args[idx+1]
  92.     elif '-isysroot' in compiler_so:
  93.         idx = compiler_so.index('-isysroot')
  94.         sysroot = compiler_so[idx+1]
  95.  
  96.     if sysroot and not os.path.isdir(sysroot):
  97.         log.warn("Compiling with an SDK that doesn't seem to exist: %s",
  98.                 sysroot)
  99.         log.warn("Please check your Xcode installation")
  100.  
  101.     return compiler_so
  102.  
  103. class UnixCCompiler(CCompiler):
  104.  
  105.     compiler_type = 'unix'
  106.  
  107.     # These are used by CCompiler in two places: the constructor sets
  108.     # instance attributes 'preprocessor', 'compiler', etc. from them, and
  109.     # 'set_executable()' allows any of these to be set.  The defaults here
  110.     # are pretty generic; they will probably have to be set by an outsider
  111.     # (eg. using information discovered by the sysconfig about building
  112.     # Python extensions).
  113.     executables = {'preprocessor' : None,
  114.                    'compiler'     : ["cc"],
  115.                    'compiler_so'  : ["cc"],
  116.                    'compiler_cxx' : ["cc"],
  117.                    'linker_so'    : ["cc", "-shared"],
  118.                    'linker_exe'   : ["cc"],
  119.                    'archiver'     : ["ar", "-cr"],
  120.                    'ranlib'       : None,
  121.                   }
  122.  
  123.     if sys.platform[:6] == "darwin":
  124.         executables['ranlib'] = ["ranlib"]
  125.  
  126.     # Needed for the filename generation methods provided by the base
  127.     # class, CCompiler.  NB. whoever instantiates/uses a particular
  128.     # UnixCCompiler instance should set 'shared_lib_ext' -- we set a
  129.     # reasonable common default here, but it's not necessarily used on all
  130.     # Unices!
  131.  
  132.     src_extensions = [".c",".C",".cc",".cxx",".cpp",".m"]
  133.     obj_extension = ".o"
  134.     static_lib_extension = ".a"
  135.     shared_lib_extension = ".so"
  136.     dylib_lib_extension = ".dylib"
  137.     static_lib_format = shared_lib_format = dylib_lib_format = "lib%s%s"
  138.     if sys.platform == "cygwin":
  139.         exe_extension = ".exe"
  140.  
  141.     def preprocess(self, source,
  142.                    output_file=None, macros=None, include_dirs=None,
  143.                    extra_preargs=None, extra_postargs=None):
  144.         ignore, macros, include_dirs = \
  145.             self._fix_compile_args(None, macros, include_dirs)
  146.         pp_opts = gen_preprocess_options(macros, include_dirs)
  147.         pp_args = self.preprocessor + pp_opts
  148.         if output_file:
  149.             pp_args.extend(['-o', output_file])
  150.         if extra_preargs:
  151.             pp_args[:0] = extra_preargs
  152.         if extra_postargs:
  153.             pp_args.extend(extra_postargs)
  154.         pp_args.append(source)
  155.  
  156.         # We need to preprocess: either we're being forced to, or we're
  157.         # generating output to stdout, or there's a target output file and
  158.         # the source file is newer than the target (or the target doesn't
  159.         # exist).
  160.         if self.force or output_file is None or newer(source, output_file):
  161.             if output_file:
  162.                 self.mkpath(os.path.dirname(output_file))
  163.             try:
  164.                 self.spawn(pp_args)
  165.             except DistutilsExecError, msg:
  166.                 raise CompileError, msg
  167.  
  168.     def _compile(self, obj, src, ext, cc_args, extra_postargs, pp_opts):
  169.         compiler_so = self.compiler_so
  170.         if sys.platform == 'darwin':
  171.             compiler_so = _darwin_compiler_fixup(compiler_so, cc_args + extra_postargs)
  172.         try:
  173.             self.spawn(compiler_so + cc_args + [src, '-o', obj] +
  174.                        extra_postargs)
  175.         except DistutilsExecError, msg:
  176.             raise CompileError, msg
  177.  
  178.     def create_static_lib(self, objects, output_libname,
  179.                           output_dir=None, debug=0, target_lang=None):
  180.         objects, output_dir = self._fix_object_args(objects, output_dir)
  181.  
  182.         output_filename = \
  183.             self.library_filename(output_libname, output_dir=output_dir)
  184.  
  185.         if self._need_link(objects, output_filename):
  186.             self.mkpath(os.path.dirname(output_filename))
  187.             self.spawn(self.archiver +
  188.                        [output_filename] +
  189.                        objects + self.objects)
  190.  
  191.             # Not many Unices required ranlib anymore -- SunOS 4.x is, I
  192.             # think the only major Unix that does.  Maybe we need some
  193.             # platform intelligence here to skip ranlib if it's not
  194.             # needed -- or maybe Python's configure script took care of
  195.             # it for us, hence the check for leading colon.
  196.             if self.ranlib:
  197.                 try:
  198.                     self.spawn(self.ranlib + [output_filename])
  199.                 except DistutilsExecError, msg:
  200.                     raise LibError, msg
  201.         else:
  202.             log.debug("skipping %s (up-to-date)", output_filename)
  203.  
  204.     def link(self, target_desc, objects,
  205.              output_filename, output_dir=None, libraries=None,
  206.              library_dirs=None, runtime_library_dirs=None,
  207.              export_symbols=None, debug=0, extra_preargs=None,
  208.              extra_postargs=None, build_temp=None, target_lang=None):
  209.         objects, output_dir = self._fix_object_args(objects, output_dir)
  210.         libraries, library_dirs, runtime_library_dirs = \
  211.             self._fix_lib_args(libraries, library_dirs, runtime_library_dirs)
  212.         # filter out standard library paths, which are not explicitely needed
  213.         # for linking
  214.         library_dirs = [dir for dir in library_dirs
  215.                         if not dir in ('/lib', '/lib64', '/usr/lib', '/usr/lib64')]
  216.         runtime_library_dirs = [dir for dir in runtime_library_dirs
  217.                                 if not dir in ('/lib', '/lib64', '/usr/lib', '/usr/lib64')]
  218.         lib_opts = gen_lib_options(self, library_dirs, runtime_library_dirs,
  219.                                    libraries)
  220.         if type(output_dir) not in (StringType, NoneType):
  221.             raise TypeError, "'output_dir' must be a string or None"
  222.         if output_dir is not None:
  223.             output_filename = os.path.join(output_dir, output_filename)
  224.  
  225.         if self._need_link(objects, output_filename):
  226.             ld_args = (objects + self.objects +
  227.                        lib_opts + ['-o', output_filename])
  228.             if debug:
  229.                 ld_args[:0] = ['-g']
  230.             if extra_preargs:
  231.                 ld_args[:0] = extra_preargs
  232.             if extra_postargs:
  233.                 ld_args.extend(extra_postargs)
  234.             self.mkpath(os.path.dirname(output_filename))
  235.             try:
  236.                 if target_desc == CCompiler.EXECUTABLE:
  237.                     linker = self.linker_exe[:]
  238.                 else:
  239.                     linker = self.linker_so[:]
  240.                 if target_lang == "c++" and self.compiler_cxx:
  241.                     # skip over environment variable settings if /usr/bin/env
  242.                     # is used to set up the linker's environment.
  243.                     # This is needed on OSX. Note: this assumes that the
  244.                     # normal and C++ compiler have the same environment
  245.                     # settings.
  246.                     i = 0
  247.                     if os.path.basename(linker[0]) == "env":
  248.                         i = 1
  249.                         while '=' in linker[i]:
  250.                             i = i + 1
  251.  
  252.                     linker[i] = self.compiler_cxx[i]
  253.  
  254.                 if sys.platform == 'darwin':
  255.                     linker = _darwin_compiler_fixup(linker, ld_args)
  256.  
  257.                 self.spawn(linker + ld_args)
  258.             except DistutilsExecError, msg:
  259.                 raise LinkError, msg
  260.         else:
  261.             log.debug("skipping %s (up-to-date)", output_filename)
  262.  
  263.     # -- Miscellaneous methods -----------------------------------------
  264.     # These are all used by the 'gen_lib_options() function, in
  265.     # ccompiler.py.
  266.  
  267.     def library_dir_option(self, dir):
  268.         return "-L" + dir
  269.  
  270.     def runtime_library_dir_option(self, dir):
  271.         # XXX Hackish, at the very least.  See Python bug #445902:
  272.         # http://sourceforge.net/tracker/index.php
  273.         #   ?func=detail&aid=445902&group_id=5470&atid=105470
  274.         # Linkers on different platforms need different options to
  275.         # specify that directories need to be added to the list of
  276.         # directories searched for dependencies when a dynamic library
  277.         # is sought.  GCC has to be told to pass the -R option through
  278.         # to the linker, whereas other compilers just know this.
  279.         # Other compilers may need something slightly different.  At
  280.         # this time, there's no way to determine this information from
  281.         # the configuration data stored in the Python installation, so
  282.         # we use this hack.
  283.         compiler = os.path.basename(sysconfig.get_config_var("CC"))
  284.         if sys.platform[:6] == "darwin":
  285.             # MacOSX's linker doesn't understand the -R flag at all
  286.             return "-L" + dir
  287.         elif sys.platform[:5] == "hp-ux":
  288.             return "+s -L" + dir
  289.         elif sys.platform[:7] == "irix646" or sys.platform[:6] == "osf1V5":
  290.             return ["-rpath", dir]
  291.         elif compiler[:3] == "gcc" or compiler[:3] == "g++":
  292.             return "-Wl,-R" + dir
  293.         else:
  294.             return "-R" + dir
  295.  
  296.     def library_option(self, lib):
  297.         return "-l" + lib
  298.  
  299.     def find_library_file(self, dirs, lib, debug=0):
  300.         shared_f = self.library_filename(lib, lib_type='shared')
  301.         dylib_f = self.library_filename(lib, lib_type='dylib')
  302.         static_f = self.library_filename(lib, lib_type='static')
  303.  
  304.         for dir in dirs:
  305.             shared = os.path.join(dir, shared_f)
  306.             dylib = os.path.join(dir, dylib_f)
  307.             static = os.path.join(dir, static_f)
  308.             # We're second-guessing the linker here, with not much hard
  309.             # data to go on: GCC seems to prefer the shared library, so I'm
  310.             # assuming that *all* Unix C compilers do.  And of course I'm
  311.             # ignoring even GCC's "-static" option.  So sue me.
  312.             if os.path.exists(dylib):
  313.                 return dylib
  314.             elif os.path.exists(shared):
  315.                 return shared
  316.             elif os.path.exists(static):
  317.                 return static
  318.  
  319.         # Oops, didn't find it in *any* of 'dirs'
  320.         return None
  321.